home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / zcfg120.arc / ZMAILCFG.DOC < prev    next >
Text File  |  1991-08-14  |  8KB  |  165 lines
  1.  
  2. Program    : ZmailCFG V1.20
  3. Copyright  : August 14 1991, LogiComp Inc.
  4. Written by : Joey P. Lindstrom
  5. Compiler   : QuickBASIC V4.5 (Copyright 1990 Microsoft)
  6.  
  7. This is a SHAREWARE program, if you use this program regularly I ask
  8. that you register it.  To do so, simply send me a postcard at the
  9. address listed at the end of this document.
  10.  
  11. Purpose: To provide an easy way for BBS System Operators to configure
  12. the excellent Zmail mail processing program.  An explanation of this
  13. program is beyond the scope of this document: it is expected that the
  14. user of ZmailCFG have some idea of what Zmail does and how it works.
  15. Having a printed manual nearby is a good idea if you are a completely
  16. new user of Zmail, but any experienced user will be able to get along
  17. just fine with the built-in help facility in ZmailCFG (using text
  18. blatantly stolen from the sample ZMAIL.CTL file that comes included
  19. with the Zmail distribution archives).
  20.  
  21. ZmailCFG works with ZMAIL.CTL files for all "flavors" of Zmail, such
  22. as ZmailH, ZmailF, ZmailQ, etc.
  23.  
  24. ZmailCFG assumes that the CURRENT DIRECTORY is where ZMAIL.CTL should
  25. be.  It will first attempt to read that file and load in all your
  26. previous settings.  If it cannot find a valid ZMAIL.CTL file, it
  27. assumes you wish to build one from scratch.  It then sets several
  28. "default settings" and immediately prompts you to tell it which
  29. version of Zmail you are using (very important information, I might
  30. add).
  31.  
  32. As you use the program, you may configure any valid ZMAIL command to
  33. your liking.  Feel free to press F1 at almost any time for help on the
  34. current command you are configuring if you have any doubt as to what
  35. to do.
  36.  
  37. ZmailCFG is designed to be fairly easy to use.  It is entirely
  38. menu-driven, simply use the CURSOR keys, PAGE-UP/PAGE-DOWN, LEFT,
  39. RIGHT, HOME, and END to move the cursor-bar around.  F1 gives you
  40. help, and ESC will always exit.  ZmailCFG was programmed by somebody
  41. with only a small amount of programming experience in the MS-DOS world,
  42. so therefore it's not quite as "polished" as some programs you may have
  43. used.  It does do what it claims to do, though.  I must apologize for
  44. the rather large size of the program, which was written completely in
  45. MicroSoft QuickBASIC V4.5.  There is a LOT of help data built into the
  46. program and it has therefore ballooned to a rather large size.
  47.  
  48. Features: when you save your work, ZmailCFG will warn you if you have
  49. failed to configure any REQUIRED parameters.  If you really want to
  50. you can still save and exit, but you will be given the chance to
  51. change your mind, go back into ZmailCFG, make some changes, and try to
  52. save again.
  53.  
  54. ZmailCFG will be updated as Zmail gets updated.  No doubt future
  55. versions of Zmail will include new configuration files that are not
  56. currently supported by ZmailCFG.  I've taken that into account: If
  57. ZmailCFG runs across any unknown keywords, it stashes them into a
  58. special memory buffer.  When you save your work, the "unknown"
  59. keywords will be saved along with it, unchanged.
  60.  
  61. It is *IMPORTANT* that you *TELL* ZmailCFG accurately which version of
  62. Zmail you are configuring.  ZmailCFG can handle any version from V1.10
  63. through V1.20 but there are several DIFFERENCES between the
  64. configurations for each of these versions.  If you are using V1.16 and
  65. have told ZmailCFG you are using V1.20, you are likely to wind up
  66. saving commands that Zmail V1.16 will choke on.
  67.  
  68. As mentioned earlier, ZmailCFG requires a certain piece of information
  69. that it normally CANNOT GET from the ZMAIL.CTL file, and that is WHICH
  70. VERSION OF ZMAIL you wish to configure for.  Rather than prompt you
  71. for this information every time you use it, ZmailCFG cheats: it stores
  72. this information in the ZMAIL.CTL file itself, hidden behind a
  73. semi-colon so that ZMAIL won't barf on it.  An example:
  74.  
  75. ;ZMAILCFGVERSION V1.13
  76.  
  77. When loading ZMAIL.CTL, ZmailCFG will interpret this line correctly,
  78. thus you don't have to tell ZmailCFG which version of Zmail you are
  79. running every time you run it.  You need update this only when you
  80. install a newer version of Zmail (which should come with a newer
  81. version of ZmailCFG as well).
  82.  
  83. ZmailCFG will not retain any comment lines (ie: hidden by semi-colons)
  84. that were in your original ZMAIL.CTL when you save it back.  I had to
  85. make a programming decision here, and to retain all this information
  86. would have required a lot more memory and some REAL hoop-jumping as
  87. far as the coding of it were concerned.  I personally feel that if
  88. one has access to a configuration program, comment lines in the config
  89. file become extraneous, unnecessary, useless, and simply a waste of
  90. space.  After all, ZmailCFG is designed to REPLACE them, right?
  91. Anyways, that's just my opinion.  If I get enough feedback from folks
  92. feeling otherwise, another ZmailCFG will be released to accomodate.
  93.  
  94. Final Words:
  95.  
  96. I decided to write this program for two reasons:
  97.  
  98. 1) A user in the ZMAIL echo conference had asked the Zmail author if
  99. such a program were available or were in the planning stages.  The
  100. author had no plans to write such a beast (hey, Zmail is a BIG ENOUGH
  101. project as it is!) in the forseeable future.  Therefore, I saw a need
  102. to fill and did what I could to fill it.
  103.  
  104. 2) I'm a firm Zmail fan.  I think it's an excellent product which I've
  105. loved since the day I got it.  Any small contribution I can make to
  106. make Zmail a better product is the least I can offer.
  107.  
  108. Hopefully I'll be coding some better, and more useful, software
  109. in the future.  For now, if anyone can find any bugs with this thing
  110. I'd sure appreciate hearing about them.... just as I'd also like to
  111. hear any other comments or feedback you may have.  I can be netmailed
  112. at:
  113.  
  114. Farpoint Station (HST/V32/V42)
  115. Phone 1-403-226-0867 & 1-403-226-0868
  116. Node 1:134/55 & 1:134/90 in FidoNet
  117. Node 99:9305/55 & 99:9305/90 in GoodEggNet
  118. Node 201:5500/55 & 201:5500/90 in MetroNet
  119.  
  120. Or snailmailed at:
  121.  
  122. Joe Lindstrom
  123. 34 Harvest Wood Link N.E.
  124. Calgary, AB, Canada
  125. T3K 3X8
  126.  
  127. Trek on!
  128.  
  129. [~] Sarek Of Farpoint [~]
  130.  
  131.  
  132. Revision History
  133. ================
  134.  
  135. V1.00   - Initial Release
  136.  
  137. V1.01   - Bug fix: editing a Node$<1 would default to 1.  ARGH!
  138.  
  139. V1.02   - Another buglet, this time in the Online Help Facility, which
  140.           would occasionally give you a blank screen until you pressed
  141.           a cursor key.  Also optimized the NODE/MAP/RETAIN entry
  142.           screens for speed, they are a bit smoother now.
  143.  
  144. V1.03   - Changed a few help screens to reflect the fact that ZmailCFG
  145.           works with all "flavors" of Zmail.
  146.         - Fixed some problems with monochrome display.
  147.  
  148. V1.16   - Zmail V1.16 was released (hot on the heels of V1.15, which
  149.           was immediately recalled due to a serious bug) with many
  150.           bugs fixed but with no changes in the ZMAIL.CTL file.  This,
  151.           therefore, is merely a maintenance release.  V1.03 of
  152.           ZmailCFG will still work fine with Zmail V1.16, but this
  153.           version should be sent along with Zmail V1.16 to anyone who
  154.           requests Zmail from you.
  155.         - Change ZmailCFG version numbers so that they will now
  156.           reflect a similar version number as the version of Zmail
  157.           that it is designed to work with.  ZmailCFG will continue to
  158.           be backwards-compatible for all previous Zmail versions back
  159.           as far as V1.10.
  160.  
  161. V1.20   - Zmail V1.20 now swaps to EMS/disk and handles record
  162.           locking.  ZmailCFG now handles the SWAPPATH, QUICKLOCK,
  163.           RALOCK, and SBBSLOCK commands.
  164.  
  165.